Skip to content

docs: fix README accuracy and add comparison table#40

Merged
robbycochran merged 3 commits into
mainfrom
rc-readme-based-improvements
Jun 6, 2026
Merged

docs: fix README accuracy and add comparison table#40
robbycochran merged 3 commits into
mainfrom
rc-readme-based-improvements

Conversation

@robbycochran

@robbycochran robbycochran commented Jun 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

  • Fix every factual error found by code-validated review (profile field names, architecture diagram, credential validation claims, project layout, testing matrix)
  • Add comparison table vs Kaiden and Plandex
  • Fix quickstart to include all prerequisites
  • Move in-sandbox provider verification from claimed-as-shipped to Future Direction
  • Show both local and remote in architecture diagram
  • Update Three Domains table to reflect config-driven gateway configs
  • Fix: pass SANDBOX_IMAGE override to launcher Job — dev/CI image overrides were not propagated to the in-cluster launcher, causing OCP sandbox create to pull the wrong image

What changed

Every claim in the README was validated against the source code. Fixes:

Issue Before After
Profile field image = quay.io/... from = ghcr.io/...
Architecture gRPC API OpenShell API (harness uses CLI exec)
Credential validation verify end-to-end inside sandbox Local preflight only, in-sandbox planned
Infrastructure config openshell.toml gateways/name/gateway.toml
Testing matrix {bash,go} x {podman,ocp} make validate-dev + unit tests
Project layout deploy/ (missing) gateways/ (3 configs)
Quick Start Missing prereqs All prerequisites included
OCP sandbox create SANDBOX_IMAGE not passed to launcher Launcher receives and respects the override

Test plan

  • go build ./... passes
  • go test ./... passes (all packages)
  • CI checks pass (lint, test, local integration)
  • make validate-dev passes (OCP full test with dev images)

robbycochran and others added 3 commits June 5, 2026 16:09
@robbycochran
X-Smart-Branch-Parent: main
f8032df
@robbycochran @claude
docs: fix README accuracy, add comparison table, fix quickstart
ca03684 
Addresses issues found in code-validated review:
- Fix profile field name (image → from) and registry URL
- Fix architecture diagram (gRPC → openshell CLI exec)
- Fix credential validation claim (in-sandbox is planned, not shipped)
- Fix Three Domains config (openshell.toml → gateways/<name>/gateway.toml)
- Fix testing section (remove stale bash x podman matrix)
- Fix project layout (deploy/ → gateways/, add PROVIDERS-SPEC.md ref)
- Add comparison table (vs Kaiden, Plandex)
- Add missing quickstart steps (install openshell, gcloud project, JIRA_URL)
- Move in-sandbox verification to Future Direction
- Show both local and remote in architecture diagram

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@robbycochran @claude
fix: pass SANDBOX_IMAGE override to launcher Job
e6c5c04 
The launcher reads the profile ConfigMap which has the original from
field baked in. When SANDBOX_IMAGE env var overrides the image (dev/CI
builds), the override was applied to the local cfg but not propagated
to the launcher running in-cluster.

Fix: pass SANDBOX_IMAGE as an env var in the Job spec, and have the
launcher respect it as an override on cfg.From.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@robbycochran robbycochran merged commit bc16498 into main Jun 6, 2026
5 checks passed
@robbycochran robbycochran deleted the rc-readme-based-improvements branch June 13, 2026 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@robbycochran